﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System;
using System.ComponentModel;
using ScrumTable.Common;
using ScrumTable.Common.Collections;
using ScrumTable.DL.Data.Common;

#endregion

namespace ScrumTable.BL.DM.DataManagement.Tracking
{
    /// <summary>
    /// Specifies the edit type of an undo action. This type can be
    /// used to display a user interface message which describes
    /// an undo action.
    /// </summary>
    public enum UndoEditType
    {
        /// <summary>
        /// Specifies that a value of a domain object property
        /// has been changed.
        /// </summary>
        ValueChange,

        /// <summary>
        /// Specifies that an object in a domain collection has
        /// changed.
        /// </summary>
        Move,

        /// <summary>
        /// Specifies that multiple action has been captured as one
        /// undo/redo action and will be executed together.
        /// </summary>
        Multiple

        //Remove,
        //Clear,
        //Add
    }

    /// <summary>
    /// Contains all required information to perform undo / redo actions.
    /// </summary>
    public interface IUndoEdit
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the state change cause.
        /// This property contains display information about the change.
        /// </summary>
        string Cause { get; }

        /// <summary>
        /// Gets the change type which means the element or action that
        /// caused the undo edit entry.
        /// </summary>
        UndoEditType Type { get; }

        /// <summary>
        /// Gets the name of the domain object which accommodates the change. 
        /// This property contains display information about the change.
        /// </summary>
        string ElementName { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        #endregion

        #region Events

        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}